/*
    This file is part of the substandard lisp implementation of Standard Lisp
    Copyright (C) 2011 Nicky Nickell

    substandard lisp is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

function std_putv(a, env) {
  var v = a[0].value;
  var index = a[1].value;
  var value = a[2];

  if ((index < 0) && (index > v.length)) {
    throw new Error('***** ' + index + ' subscript is out of range');
  } else {
    v[index] = value;
    return value
  }
}

/*---
name: putv
arity: 3
rest: false
ftype: FTYPE_EXPR

argument-types:
  - TYPE_VECTOR
  - TYPE_INTEGER
  - CLASS_ANY

doc: |
  explaining what putv is / how it is used!

tests: |
  (setq vect (mkvect 5))
  (putv vect 5 5) -> 5
  vect -> [NIL, NIL, NIL, NIL, NIL, 5]
  (putv vect 1 1) -> 1
  vect -> [NIL, 1, NIL, NIL, NIL, 5]
...*/
